/*
 * Copyright (c) 2009-2010, okazoh_tk. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *  - Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *  - Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *  - Neither the name of the copyright holder nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef ALKES_LOCK_IMAGE_BUFFER_H_INCLUDED_
#define ALKES_LOCK_IMAGE_BUFFER_H_INCLUDED_

#include "alkes/internal.h"
#include "alkes/media/ImageBuffer.h"

namespace alkes {

/// \addtogroup media
//@{


class AL_EXPORT LockImageBuffer
{
public:
    LockImageBuffer(ImageBuffer* image, uint32_t lock_mode, const Rect* rect = 0);
    ~LockImageBuffer();

    void detach();

    PixelFormat getPixelFormat() const;
    void getImageSize(uint16_t& width, uint16_t& height) const;
    uint16_t getImageWidth() const;
    uint16_t getImageHeight() const;
    int32_t getPitch() const;

protected:
    void* getBuffer() const;

private:
    ImageBuffer* image_;
    int32_t pitch_;
    void* buffer_;
};

class AL_EXPORT LockImageBufferRead
    : public LockImageBuffer
{
public:
    LockImageBufferRead(ImageBuffer* image, const Rect* rect = 0);

    operator const uint8_t* () const;
};

class AL_EXPORT LockImageBufferWritable
    : public LockImageBuffer
{
public:
    LockImageBufferWritable(ImageBuffer* image, bool readable, const Rect* rect);

    operator uint8_t* () const;
};

class AL_EXPORT LockImageBufferWrite
    : public LockImageBufferWritable
{
public:
    LockImageBufferWrite(ImageBuffer* image, const Rect* rect = 0);
};

class AL_EXPORT LockImageBufferReadWrite
    : public LockImageBufferWritable
{
public:
    LockImageBufferReadWrite(ImageBuffer* image, const Rect* rect = 0);
};


//@}

}

#endif
